
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>vOMCI reference implementation &#8212; vomci  documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/extra.css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="1. Database Service" href="database/index.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="database/index.html" title="1. Database Service"
             accesskey="N">next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">vomci  documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">vOMCI reference implementation</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="vomci-reference-implementation">
<h1>vOMCI reference implementation<a class="headerlink" href="#vomci-reference-implementation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="contents">
<h2 class="display-none">Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<p><!-- toctree --></p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="database/index.html">1. Database Service</a><ul>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#module-database.omci_me">1.1. OMCI Attr and ME Base Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#module-database.omci_me_types">1.2. OMCI ME Classes and Data Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#module-database.omci_onu_mib">1.3. ONU MIB: Searchable ME collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="database/index.html#module-database.omci_olt">1.4. OLT Database: Searchable collections of OLTs and ONUs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="encode_decode/index.html">2. OMCI Message Encode / Decode Service</a><ul>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_create">2.1. Create Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_delete">2.2. Delete Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_set">2.3. Set Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_get">2.4. Get Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_mib_reset">2.5. MIB Reset Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#module-encode_decode.omci_action_mib_upload">2.6. MIB Upload Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="encode_decode/index.html#mib-upload-next-action">2.7. MIB Upload Next Action</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="omcc/index.html">3. OMCC Service (OMH SBI)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="omcc/index.html#module-omcc.grpc.omci_channel_grpc">3.1. gRPC Channel</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="omh_nbi/index.html">4. OMH NBI</a><ul>
<li class="toctree-l2"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.onu_driver">4.1. ONU Driver</a></li>
<li class="toctree-l2"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.omh_handler">4.2. OMH Request Handler Base Class</a></li>
<li class="toctree-l2"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.omh_handler_utils">4.3. OMH Handler Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="omh_nbi/index.html#omh-request-handlers">4.4. OMH Request Handlers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.onu_mib_reset">Reset ONU MIB</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.onu_mib_upload">Upload ONU MIB</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.onu_activate">Activate ONU</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.uni_set">Setup ONU UNI</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.tcont_create">Create a TCONT</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.gem_port_create">Create a GEM Port</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.qos_policy_profile_set">Create a QoS Policy Profile (802.1p Mapper SVC Profile ME and GEM IW TP MEs)</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.vlan_subinterface_set">Create a VLAN Sub-Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="omh_nbi/index.html#module-omh_nbi.handlers.ip_host_config_set">Set IP_HOST_CONFIG_DATA</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bin/index.html">5. Test Programs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#bintest_onu_fsm-invoke-any-onu-fsm">5.1. bin/test_onu_fsm: Invoke any ONU FSM</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#bintest_activate_onu-invoke-onu-activation-fsm">5.2. bin.test_activate_onu: Invoke ONU activation FSM</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#bintest_uni_tcont_gem-activate-onu-and-configure-uni-tcont-and-gem-port">5.3. bin.test_uni_tcont_gem: Activate ONU and configure UNI, TCONT and GEM port</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#bintest_qos_policy_profile-create-qos-policy-profile">5.4. bin.test_qos_policy_profile: Create QoS Policy Profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin/index.html#bintest_vlan_subinterface-create-a-vlan-sub-interface">5.5. bin.test_vlan_subinterface: Create a VLAN Sub-Interface</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">vOMCI reference implementation</a><ul>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="database/index.html"
                        title="next chapter"><span class="section-number">1. </span>Database Service</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/index.md.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="database/index.html" title="1. Database Service"
             >next</a> |</li>
        <li class="nav-item nav-item-0"><a href="#">vomci  documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">vOMCI reference implementation</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, Broadband Forum.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.0+.
    </div>
  </body>
</html>